home *** CD-ROM | disk | FTP | other *** search
/ Aminet 19 / Aminet 19 (1997)(GTI - Schatztruhe)[!][Jun 1997].iso / Aminet / util / dir / Find.readme < prev    next >
Text File  |  1997-05-03  |  4KB  |  142 lines
  1. Short:    File Finder (custom output and search)
  2. Author:   soenke.tesch@elmshorn.netsurf.de
  3. Uploader: soenke.tesch@elmshorn.netsurf.de
  4. Type:     util/dir
  5.  
  6. What`s it all about?
  7. ====================
  8.  
  9. This is probably the 10312. implementation of a File Finder. Anyway, I
  10. spend a full 2½ hours on this and therefore I like it best :)
  11.  
  12. Find will search in a directory and its subdirectories for objects matching
  13. a given pattern. You can say where and how deep Find should search and if
  14. it should return only files or directories or both.
  15. The output is customizable.
  16.  
  17. Find does not need any extra libraries and does not feature a text viewer,
  18. database or coffee-machine. Want a fancy MUI user interface with fiftythousand
  19. buttons? Go and look for another program, Find is CLI-only ;)
  20.  
  21.  
  22. Short instructions
  23. ==================
  24.  
  25.   Find PATTERN/A,ROOTDIR,DEPTH/N/K,DIRS/S,FILES/S,STATS/S,QUIET/S,LFORMAT=FORMAT/K
  26.  
  27.   PATTERN
  28.     Name of the file or directory you are looking for. This string may
  29.     also contain standard AmigaDOS wildcards like #,?,~ etc. Please see
  30.     your AmigaDOS manual for further details.
  31.  
  32.   ROOTDIR
  33.     Find usually starts searching in the current directory and its sub-
  34.     directories. Setting ROOTDIR to something else will change this.
  35.     If you want e.g. search for your great EggPaint in your complete
  36.     first harddisk, you can use one of the following:
  37.  
  38.       find EggPaint dh0:
  39.       find EggPaint rootdir dh0:
  40.       find EggPaint MyFirstDisk:
  41.  
  42.   DEPTH
  43.     Maximum level of sub-directories Find will search in. The current
  44.     directory (or ROOTDIR if used) is level 0.
  45.  
  46.       find EggPaint dh0: depth 0
  47.  
  48.     will thus search only in the current directory.
  49.     The default is unlimited.
  50.  
  51.     BE CAREFUL: If Find finds a matching link it will return the path
  52.     and filename of the file the link points to, _not_ of the link!
  53.     Therefore you may get files very deep in your directory tree
  54.     although you set DEPTH to 1 or even 0.
  55.     Not my fault, this is the behaviour of the NameFromLock() function
  56.     in dos.library..:/
  57.  
  58.   DIRS
  59.     Find returns only directories matching PATTERN.
  60.  
  61.   FILES
  62.     Find returns only files matching PATTERN.
  63.  
  64.   STATS
  65.     Find will print an some extra information after the search, e.g.
  66.  
  67.       1 files and 5 directories in 2 of 7 places
  68.  
  69.     This means Find found 1 matching file and 5 matching directories
  70.     in 2 directories. Find searched in a total of 7 directories.
  71.  
  72.   QUIET
  73.     By default Find prints some information about where it is currently
  74.     looking for matching objects to the Shell window. This output can be
  75.     switched off by setting QUIET.
  76.  
  77.   LFORMAT or FORMAT
  78.     This is the similar to the c:list argument LFORMAT. The given string
  79.     is written to the output for every matching object. Every %s in this
  80.     string is replaced by the complete path.
  81.  
  82.     Example:
  83.  
  84.       Find EggPaint format "Found the magnificent %s*n"
  85.  
  86.     might output
  87.  
  88.       Found the magnificent MyFirstDisk:Gfx/EggPaint
  89.  
  90.     BE CAREFUL: If you want the cursor to move to the beginning of next
  91.     line at the end of the string you have to put *n at the end of the
  92.     template.
  93.  
  94.  
  95. Copyright
  96. =========
  97.  
  98.   Find and Find.readme are copyrighted by Sönke Tesch 1997.
  99.   All Rights Reserved.
  100.  
  101.   You may re-distribute the archive as long as no file is removed or
  102.   changed.
  103.   Find has to be distributed for FREE, any other kind of distribution
  104.   without my written permission is not allowed. However, this is not
  105.   the case for any AmiNet- or Fred Fish-disks.
  106.   I do not give any guarantee for the quality and usefulness of Find!
  107.  
  108.  
  109. Contact
  110. =======
  111.  
  112.   To contact me via mail write to <soenke.tesch@elmshorn.netsurf.de>.
  113.  
  114.  
  115. History (do we have one yet:)
  116. =============================
  117.  
  118.   19-Apr-97 a Version 1.00 on Aminet
  119.  
  120.  
  121. Those finer details..
  122. =====================
  123.  
  124.   Find is written using Cyclone Modula-2 by Marcel Timmermans.
  125.   The source is available on request, just ask.
  126.  
  127.  
  128. --
  129. Amiga Translators Organization * Main & German Admin, Ex-Human Listserver
  130. ato    : ato-admin@ato.vapor.com & ato-admin-de@ato.vapor.com
  131. private: soenke.tesch@elmshorn.netsurf.de
  132.  
  133.  
  134. ============================= Archive contents =============================
  135.  
  136. Original  Packed Ratio    Date     Time    Name
  137. -------- ------- ----- --------- --------  -------------
  138.     3196    1837 42.5% 24-Apr-97 16:57:20  Find
  139.     4108    1926 53.1% 29-Apr-97 02:21:14  find.readme
  140. -------- ------- ----- --------- --------
  141.     7304    3763 48.4% 30-Apr-97 14:56:20   2 files
  142.